-
Notifications
You must be signed in to change notification settings - Fork 999
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for output action attributes #13236
Conversation
- document that tool provided metadata should be preferred over the ``actions`` tag. galaxyproject/planemo#1167 should be merged first - add documentation for tags - + 2 TODOs in tool_util/parser/output_actions.py
lib/galaxy/tool_util/xsd/galaxy.xsd
Outdated
@@ -4857,6 +4857,8 @@ Galaxy, including: | |||
<xs:complexType name="Actions"> | |||
<xs:annotation> | |||
<xs:documentation xml:lang="en"><![CDATA[ | |||
The functionality of the ``actions`` tag should be replaced by | |||
[tool provided metadata](https://planemo.readthedocs.io/en/latest/writing_advanced.html#tool-provided-metadata). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just don't know that I think this is true. The XML may be undocumented but at least it is structured and declarative. In terms of how the workflow editor works, job collection, etc.. it seems we can be a lot smarter about output actions. It feels like tool provided metadata should be the fallback (despite me knowing a lot more about it and such).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these the actions this refers to ? https://docs.galaxyproject.org/en/master/dev/schema.html#tool-outputs-data-actions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these the actions this refers to ?
Yes
I just don't know that I think this is true.
That is such a wonderful sentence ;).
So let's just remove my sentence about the tool provided metadata.
This PR was merged without a "kind/" label, please correct. |
For #12724 I tried to understand output actions. Have to admit that even after studying the code I have no idea (that goes beyond the examples in the docs) what they are doing .. also they seem overly complex. Maybe this bit of added documentation is a small step forward ... But I also added a statement that tool provided metadata should be used instead (which is undocumented to a similar extent).
actions
tag. fix and complete metadata setting docs planemo#1167 needs to be finished firstHow to test the changes?
(Select all options that apply)
License